|
|
PBGetFCBInfoSync |
||||
| Header: | Files.h | Carbon status: | Supported | |
Gets information about an open file.
OSErr PBGetFCBInfoSync (
FCBPBPtr paramBlock
);
A pointer to a file control block parameter block.
A result code.
The relevant fields of the parameter block are:
On input, a pointer to a completion function.
On output, the result code of the function.
On input, a pointer to a pathname. You should pass a pointer to a Str31 value if you want that name returned. If you pass NULL in the ioNamePtr field, no filename is returned.
On output, if PBGetFCBInfoSync executes successfully, the ioNamePtr field contains the name of the specified open file.
On input, a volume specification. This field may contain a drive number, volume reference number, or working directory reference number. If the value of ioVRefNum is 0, all open files are indexed; otherwise, only open files on the specified volume are indexed.
On input, if ioFCBIndx is 0, the file reference number of the file to get information about. If the value of ioFCBIndx is positive, the ioRefNum field is ignored on input and contains the file reference number on output.
On input, an index. If the value of ioFCBIndx is positive, the File Manager returns information about the file whose index in the FCB buffer is ioFCBIndx and that is located on the volume specified by ioVRefNum.
If the value of ioFCBIndx is 0, the File Manager returns information about the file whose file reference number is specified by the ioRefNum field. If the value of ioFCBIndx is positive, the ioRefNum field is ignored on input and contains the file reference number on output.
On output, the file ID.
On output, file status flags. See FCBPBRec for a description of the meaning of the bits in this field.
On output, the first allocation block of the file.
On output, the logical end-of-file.
On output, the physical end-of-file.
On output, the position of the file mark.
On output, the volume reference number.
On output, the file clump size.
On output, the parent directory ID.
Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.
© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)